home *** CD-ROM | disk | FTP | other *** search
/ Turnbull China Bikeride / Turnbull China Bikeride - Disc 2.iso / ACORNUSERS / CBSA / INTERNET / QIRC / !QuickIRC / !Help < prev    next >
Text File  |  1997-12-28  |  11KB  |  321 lines
  1.  
  2.  
  3.         #####                             #####  #####     ######
  4.        #     #           #                  #    #    #   #
  5.       #       #                   #  #      #    #    #   #
  6.       #       #   #   #  #  ####  # #       #    #####    #
  7.       #    #  #   #   #  #  #     ##        #    # #      #
  8.        #     #    #   #  #  #     # #       #    #  #     #
  9.         ##### #    ###   #  ####  #  #    #####  #   ##    ######
  10.         
  11.         
  12.         
  13.              A Command Macro Program For Internet Relay Chat
  14.                    Version 1.2 November 1997
  15.            
  16.            
  17.            Author :
  18.            
  19.                     David Robinson,
  20.                     6 St James Road,
  21.                     Torpoint,
  22.                     Cornwall.
  23.                     PL11 2BQ
  24.            
  25.                     E-Mail:  software@zephryus.demon.co.uk
  26.                     
  27.                     ************************************ 
  28.                     *** The best way to learn how to ***
  29.                     *** use this software is to play *** 
  30.                     ***          with it             ***
  31.                     ************************************                  
  32.  
  33.  
  34. Changes since version 1.1
  35.  
  36. 1. Shortcuts for three new commands: List, Lastlog and Trace.
  37. 2. User defined Logoff messages.
  38. 3. Unlimited number of user defined 'Actions' files.
  39. 4. Unlimited number of user defined 'Away' files.
  40. 5. One click entry of smilies.
  41. 6. Zap/Menu bug fixed
  42.                
  43.  
  44. CONTENTS
  45. --------
  46.  
  47. 1. About QuickIRC
  48. 2. Requirements
  49. 3. Setting up QuickIRC
  50. 4. Editing user defined options such as menus and text files.
  51. 5. Using QuickIRC in an IRC session
  52. 6. Bugs and Problems including ‘file not found’
  53. 7. Legal Stuff
  54.  
  55.  
  56.  
  57. 1. About !QuickIRC
  58. ~~~~~~~~~~~~~~~~~~
  59.  
  60. QuickIRC is a shareware IRC Command program. It is intended to make the
  61. entry of irc commands easier and quicker, especially if you find
  62. typing difficult, or are new to IRC and its command structures.
  63.  
  64. Its features include...
  65.  
  66. • One click entry of commands including nicknames and channels.
  67.  
  68. • User definable lists of most frequently used nicknames and channels.
  69.  
  70. • Support for advanced CTCP irc commands such as finger and version.
  71.  
  72. • Operator commands such as Ops, Private, Secret etc
  73.  
  74. • Sends output to the currently selected irc window or icon.
  75.  
  76. • Makes issuing commands simple for even first time irc users.
  77.  
  78. • Full interactive help, often including examples.
  79.  
  80. • User definable selections of /Away reasons, /Quit messages and /Me actions.
  81.                    
  82.                    
  83.  
  84. 2.Requirements
  85. ~~~~~~~~~~~~~~
  86. QuickIRC requires RiscOS 3.1 or later. Ideally it should be installed
  87. on a hard drive since it accesses data files from time to time whilst
  88. in use.
  89.  
  90. It will work on any system where an irc connection can be established.  
  91. It can be used with irc client programs such as IRClient, or with Telnet 
  92. sessions ( the only option available if you connect to the internet using 
  93. DoggySoft’s Termite software.) It has been tested on Efnet, Undernet,
  94. Dalnet and via raw Telnet to irc.demon.co.uk
  95.  
  96.  
  97.  
  98.  
  99. 3.Setting Up QuickIRC
  100. ~~~~~~~~~~~~~~~~~~~~~
  101.  
  102. Essentially QuickIRC needs almost no setting up. It can be happily run
  103. in it’s original state.  However, to get most benefit from using it,
  104. you should edit the nickname and channel name files to contain the
  105. names and channels you use most frequently.
  106.  
  107.  
  108. 4. Editing Nicknames, Channels, User Names, and other menu options
  109. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  110.  
  111. BEFORE you manually edit any files, I strongly suggest you make a back
  112. up copy - just in case.
  113.  
  114. Almost all QuickIRC's menu entries can be editied to suit your needs.
  115. You can, for example, add new smilies, /List search
  116. parameters, /Me actions, reasons for being away, or messages to send when
  117. you quit a channel.
  118.  
  119. Method 1: ( For Nicknames, Channels and Countries )
  120. Adjust Clicking on commands which act on Nicknames, Countries or
  121. Channels will open a menu showing the current options. At the bottom
  122. of the menu is an option to add new entries.  If you follow it, a
  123. dialogue window will appear into which you can enter new details. 
  124. Any number of new entries can be made, just click on the ‘Add’ button
  125. after each entry.  Entries can only be added, not deleted using this method.
  126.  
  127.  
  128. Method 2:
  129.  
  130. With !QuickIRC loaded on the icon bar, and a text editor loaded,
  131. click the mouse menu button over the QuickIRC iconbar icon, then
  132. select from the options displayed. These are currently...
  133.  
  134.      NickNames
  135.      Channels
  136.      User Names
  137.      Countries
  138.      LastLog
  139.      List
  140.      Smilies
  141.      LogOff
  142.      Away Reasons =>
  143.      Actions =>
  144.  
  145.  
  146. Click on the option you want and QuickIRC will open an editor window
  147. containing the contents of the chosen file.
  148.  
  149. You can now add to, delete from, or alter the contents of the file. 
  150. Closing the window and saving the file makes the alterations take effect
  151. immediately.
  152.  
  153. All entries should be on separate lines terminated with a <RETURN>. 
  154. Channel names should begin with either a & or a #.
  155.  
  156. Away reasons and Actions both lead to further menus showing all the
  157. user created files for each option.
  158.  
  159. NB. Clicking on Away Reasons or Actions will open the directory where
  160. all the related files are stored. Clicking on individual files from
  161. the sub-menus will only open the file you selected. 
  162.  
  163.  
  164. Files you CAN edit are stored in the 'Resources.MenuDefs' Directory.
  165.  
  166. DO NOT EDIT ANYTHING in the 'Resources.Fixed' Directory - QuickIRC wont
  167. like it!
  168.  
  169.  
  170.  
  171. 5. Using QuickIRC in an IRC session
  172. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  173.  
  174. a. IRC Commands:
  175.  
  176. Using QuickIRC is the same whether you have connected via a client
  177. program or via Telnet.
  178.  
  179. Load QuickIRC and it’s icon will appear on the icon bar.  A window
  180. containing the command buttons  will appear.
  181.  
  182. Ensure that the irc client / telnet program has the current text
  183. input. In other words that the text caret is in the icon where you
  184. enter text into your IRC program.  Clicking on
  185. any of QuickIRC’s buttons will now cause the chosen command to be
  186. entered in the irc window.  Commands which require a nickname or
  187. channel name will use the names currently displayed in the Nickname
  188. and Channel display icons. Many buttons allow the use of the ADJUST
  189. button to bring up a menu of available names or options.
  190.  
  191. The Nicknames and Channel names can be changed by clicking on the menu
  192. buttons and choosing a new entry from the menu.  See “Editing
  193. Nicknames,Channels etc” for details of how to add new entries.
  194.  
  195. b. Actions:
  196.  
  197. By clicking ADJUST over the /Me button you can open the Actions Menu.
  198. This shows all the Actions files you have loaded. Clicking on a file
  199. opens it's contents in the Actions Window.
  200. This contains ten user definable messages.  These are ‘action’ messages 
  201. which you can send by just clicking on your chosen message.
  202.  
  203. Where you see <nick> in a message, QuickIRC will substitute the
  204. currently selected nickname.  
  205.  
  206. For example, if you have “Charlie” in the Nickname display and click 
  207. on “waves to <nick>”, the message entered in your irc program will be... 
  208.  
  209. /me waves at Charlie
  210.  
  211. Assuming that your irc nickname is Camilla, all other users on your irc
  212. channel will receive a message saying...
  213.  
  214. Camilla waves at Charlie.
  215.  
  216. Action messages can be edited by selecting “Actions” from the Icon Bar
  217. Menu.
  218.  
  219. c. Away Reasons
  220.  
  221. By clicking ADJUST over the /Away button you can open the Away Reasons
  222. Menu.
  223. This shows all the Away Reasons files you have loaded. Selecting a
  224. file opens it in the Away Window.
  225. This contains ten user definable messages.  These are messages 
  226. which explain why you are not currently looking at the computer
  227. screen.
  228.  
  229. They can be edited by selecting “Away Reasons” from the Icon Bar Menu.
  230.  
  231.  
  232. d. LogOff
  233.  
  234. Similar to the above but since there is only one file, Adjust clicking
  235. opens the LogOff Window directly.
  236.  
  237.  
  238.  
  239. 6.Bugs and Problems
  240. ~~~~~~~~~~~~~~~~~
  241.  
  242. Well... I’ve tried to remove as many of the bugs as possible but
  243. somebody is bound to find some more.  Please let me know what they are
  244. and try to let me have as much info as possible about what you were
  245. doing, what QuickIRC did and what type of computer you were using.
  246.  
  247. As for problems, you will find that some of the commands are not supported 
  248. by the current version of Matthew Godbolt’s !IRClient program, but this may 
  249. change with future releases.  ALL commands will work via Telnet to
  250. Demon’s irc server on irc.demon.co.uk  :  port 23
  251.  
  252.  
  253. If you accidentally delete or otherwise render useless either the
  254. nicknames or channels list files, QuickIRC will try to tell you
  255. politely about it.
  256.  
  257. To re-create the files open up QuickIRC and enter the Resources
  258. directory. Copy a default version from the directory called Backup.
  259. Now add your favourite channels and names to the files, one entry per
  260. line.
  261.  
  262.  
  263. Acknowledgements
  264. ================
  265. This program was written using !Zap, an excellent editor by Dominic
  266. Symes.
  267.  
  268. Thanks to those users who have registered for their honesty and
  269. suggestions for improvements.
  270.  
  271. In a twisted way, thanks to Doggysoft, for if they’d provided an irc
  272. client for Termite I would never have written this application ;->  
  273.  
  274. Comments and contributions welcome :)
  275.  
  276.  
  277. 7.Legal Stuff
  278. ~~~~~~~~~~~~~
  279.  
  280. QuickIRC is Shareware, not Public Domain. This means that you can
  281. freely use, copy or distribute the program, subject to the rules
  282. below, but I retain copyright on the program.
  283.  
  284. “Freely use, copy or distribute the program” means...
  285.  
  286. You can have as many copies as you want.
  287. You do not have to pay for the software until you’ve tried it.
  288. You may give it away to whomever you like.
  289.  
  290. BUT....
  291.  
  292. You may NOT alter it then redistribute it, except for changing the
  293. user definable text files, or adding foreign language message files.
  294.  
  295. The first people to send me foreign language files that I don’t yet
  296. have, get a free registered copy.
  297.  
  298. You may neither charge for it as an individual item nor as part
  299. of a compilation of software, unless you have first obtained my
  300. written permission.
  301.  
  302. If you intend placing a copy in a public archive, BBS, magazine disc
  303. or internet location, you should first contact me to ascertain whether
  304. you have the most recent version. 
  305.  
  306. Failure to do so is assumed to be, on your part, agreement to pay me
  307. a fee of 50 ukp in respect of every copy of the software that you produce
  308. without having sought my permission.
  309.  
  310. These restrictions are simply to ensure that anyone using QuickIRC
  311. gets it for little or no cost and has access to the most recent
  312. version.
  313.  
  314. If you have used !QuickIRC for a while and decide you want to keep it
  315. you should consider sending me 5 uk pounds as a registration fee.  I’m
  316. not going to force you to send me any money, but if you think it’s
  317. worth it I could certainly do with the cash, and it will help to
  318. ensure that I keep writing applications :) 
  319.  
  320.  
  321. David